Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

list API in alphabetical order #316

Merged
merged 9 commits into from
May 11, 2021
Merged

list API in alphabetical order #316

merged 9 commits into from
May 11, 2021

Conversation

raybellwaves
Copy link
Member

@raybellwaves raybellwaves commented May 9, 2021 •
edited
Loading

Started to work on #271. Opting to do small PR's. This (very slightly) tidy's up the one notebook we have and puts the API reference in alphabetical order.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

@codecov
Copy link

codecov bot commented May 9, 2021 •
edited
Loading

Codecov Report

Merging #316 (7f13685) into main (1e434a4) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #316   +/-   ##
=======================================
  Coverage   94.57%   94.57%           
=======================================
  Files          23       23           
  Lines        2601     2601           
=======================================
  Hits         2460     2460           
  Misses        141      141
Impacted Files Coverage Δ
xskillscore/core/contingency.py 95.68% <ø> (ø)
xskillscore/core/deterministic.py 97.69% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c14d780...7f13685. Read the comment docs.

@raybellwaves
Copy link
Member Author

@dougiesquire mind checking I synced up the contengency scores with sklearn naming?

I've added the See Also a couple places in contingency.py. Think i've got the ones I know. The full list of sklean metrics are here: https://scikit-learn.org/stable/modules/model_evaluation.html#classification-metrics

In quick-start.ipynb I also added other names for the metrics (see below).

* Accuracy (`accuracy`)
* Bias Score (`bias_score`)
* Equitable Threat Score (`equit_threat_score`)
* False Alarms / False Positives (`false_alarms`)
* False Alarm Ratio / False Discovery Rate (`false_alarm_ratio`)
* False Alarm Rate / False Positive Rate / Fall-out (`false_alarm_rate`)
* Gerrity Score (`gerrity_score`)
* Heidke Score / Cohan Kappa (`heidke_score`)
* Hit Rate / Recall / Sensitivity / True Positive Rate (`hit_rate`)
* Hits / True Positives (`hits`)
* Misses / False Negatives (`misses`)
* Odds Ratio (`odds_ratio`)
* Odds Ratio Skill Score (`odds_ratio_skill_score`)
* Peirce Score (`peirce_score`)
* Receiver Operating Characteristic (`roc`)
* Success Ratio / Precision / Positive Predictive Value (`success_ratio`)
* Threat Score / Critical Success Index (`threat_score`)

dougiesquire
dougiesquire reviewed May 10, 2021
View reviewed changes
docs/source/quick-start.ipynb
@@ -6,7 +6,7 @@
"source": [
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be "Cohen's Kappa"


Reply via ReviewNB

dougiesquire
dougiesquire approved these changes May 10, 2021
View reviewed changes
Copy link
Collaborator

@dougiesquire dougiesquire left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All checks out to me 👍

@raybellwaves raybellwaves merged commit 2754d60 into xarray-contrib:main May 11, 2021
@raybellwaves raybellwaves deleted the more-nbs branch May 11, 2021 04:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dougiesquire dougiesquire dougiesquire approved these changes

@aaronspring aaronspring aaronspring approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@raybellwaves @aaronspring @dougiesquire